Create or update business partners from uploaded CSV file
Create or update generic business partners. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a requested file.
- multipart/form-data
Request Body
- file binary required
- 200
- 400
Business partners were successfully updated or created
- application/json
- multipart/form-data
- Schema
- Example (from schema)
Schema array
- externalId string
The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
- nameParts string[]
The list of name parts to accommodate the different number of name fields in different systems.
identifiers object[]
The list of identifiers of the business partner. Sorted and duplicates removed by the service.
type stringThe type of the identifier.
value stringThe value of the identifier like “DE123465789.
issuingBody stringThe name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart.
states object[]
The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
- roles string[]
Possible values: [
SUPPLIER
,CUSTOMER
,ONE_TIME_SUPPLIER
,ONE_TIME_CUSTOMER
]One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.
- isOwnCompanyData boolean
Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
legalEntity object
The legal entity, on which the business partner provides a view.
legalEntityBpn stringThe BPNL of the legal entity, on which the business partner provides a view.
legalName stringThe name of the legal entity, on which the business partner provides a view, according to official registers.
shortName stringThe abbreviated name of the legal entity, on which the business partner provides a view.
legalForm stringThe legal form of the legal entity, on which the business partner provides a view.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
site object
The site, on which the business partner provides a view.
siteBpn stringThe BPNS of the site, on which the business partner provides a view.
name stringThe name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
address object
The address, on which the business partner provides a view.
addressBpn stringThe BPNA of the address, on which the business partner provides a view.
name stringThe name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
addressType stringPossible values: [
LegalAndSiteMainAddress
,LegalAddress
,SiteMainAddress
,AdditionalAddress
]One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address.
physicalPostalAddress object
A physical postal address describes the physical location of an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
name stringThe name of the street.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
taxJurisdictionCode stringTax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms.
alternativePostalAddress object
An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber stringThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
- createdAt date-time
The date when the data record has been created.
- updatedAt date-time
The date when the data record has been last updated.
[
{
"externalId": "string",
"nameParts": [
"string"
],
"identifiers": [
{
"type": "string",
"value": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"roles": [
"SUPPLIER"
],
"isOwnCompanyData": true,
"legalEntity": {
"legalEntityBpn": "string",
"legalName": "string",
"shortName": "string",
"legalForm": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"site": {
"siteBpn": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"address": {
"addressBpn": "string",
"name": "string",
"addressType": "LegalAndSiteMainAddress",
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"namePrefix": "string",
"additionalNamePrefix": "string",
"name": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"createdAt": "2024-07-15",
"updatedAt": "2024-07-15"
}
]
- Schema
- Example (from schema)
Schema array
- externalId string
The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
- nameParts string[]
The list of name parts to accommodate the different number of name fields in different systems.
identifiers object[]
The list of identifiers of the business partner. Sorted and duplicates removed by the service.
type stringThe type of the identifier.
value stringThe value of the identifier like “DE123465789.
issuingBody stringThe name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart.
states object[]
The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
- roles string[]
Possible values: [
SUPPLIER
,CUSTOMER
,ONE_TIME_SUPPLIER
,ONE_TIME_CUSTOMER
]One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.
- isOwnCompanyData boolean
Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
legalEntity object
The legal entity, on which the business partner provides a view.
legalEntityBpn stringThe BPNL of the legal entity, on which the business partner provides a view.
legalName stringThe name of the legal entity, on which the business partner provides a view, according to official registers.
shortName stringThe abbreviated name of the legal entity, on which the business partner provides a view.
legalForm stringThe legal form of the legal entity, on which the business partner provides a view.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
site object
The site, on which the business partner provides a view.
siteBpn stringThe BPNS of the site, on which the business partner provides a view.
name stringThe name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
address object
The address, on which the business partner provides a view.
addressBpn stringThe BPNA of the address, on which the business partner provides a view.
name stringThe name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
addressType stringPossible values: [
LegalAndSiteMainAddress
,LegalAddress
,SiteMainAddress
,AdditionalAddress
]One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address.
physicalPostalAddress object
A physical postal address describes the physical location of an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
name stringThe name of the street.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
taxJurisdictionCode stringTax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms.
alternativePostalAddress object
An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber stringThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
states object[]
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
- createdAt date-time
The date when the data record has been created.
- updatedAt date-time
The date when the data record has been last updated.
[
{
"externalId": "string",
"nameParts": [
"string"
],
"identifiers": [
{
"type": "string",
"value": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"roles": [
"SUPPLIER"
],
"isOwnCompanyData": true,
"legalEntity": {
"legalEntityBpn": "string",
"legalName": "string",
"shortName": "string",
"legalForm": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"site": {
"siteBpn": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"address": {
"addressBpn": "string",
"name": "string",
"addressType": "LegalAndSiteMainAddress",
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"namePrefix": "string",
"additionalNamePrefix": "string",
"name": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
]
},
"createdAt": "2024-07-15",
"updatedAt": "2024-07-15"
}
]
On malformed Business partner upload request
- application/json
- Schema
- Example (from schema)
Schema
- timestamp date-time
Timestamp of the error occurrence
- status string
Possible values: [
100 CONTINUE
,101 SWITCHING_PROTOCOLS
,102 PROCESSING
,103 EARLY_HINTS
,103 CHECKPOINT
,200 OK
,201 CREATED
,202 ACCEPTED
,203 NON_AUTHORITATIVE_INFORMATION
,204 NO_CONTENT
,205 RESET_CONTENT
,206 PARTIAL_CONTENT
,207 MULTI_STATUS
,208 ALREADY_REPORTED
,226 IM_USED
,300 MULTIPLE_CHOICES
,301 MOVED_PERMANENTLY
,302 FOUND
,302 MOVED_TEMPORARILY
,303 SEE_OTHER
,304 NOT_MODIFIED
,305 USE_PROXY
,307 TEMPORARY_REDIRECT
,308 PERMANENT_REDIRECT
,400 BAD_REQUEST
,401 UNAUTHORIZED
,402 PAYMENT_REQUIRED
,403 FORBIDDEN
,404 NOT_FOUND
,405 METHOD_NOT_ALLOWED
,406 NOT_ACCEPTABLE
,407 PROXY_AUTHENTICATION_REQUIRED
,408 REQUEST_TIMEOUT
,409 CONFLICT
,410 GONE
,411 LENGTH_REQUIRED
,412 PRECONDITION_FAILED
,413 PAYLOAD_TOO_LARGE
,413 REQUEST_ENTITY_TOO_LARGE
,414 URI_TOO_LONG
,414 REQUEST_URI_TOO_LONG
,415 UNSUPPORTED_MEDIA_TYPE
,416 REQUESTED_RANGE_NOT_SATISFIABLE
,417 EXPECTATION_FAILED
,418 I_AM_A_TEAPOT
,419 INSUFFICIENT_SPACE_ON_RESOURCE
,420 METHOD_FAILURE
,421 DESTINATION_LOCKED
,422 UNPROCESSABLE_ENTITY
,423 LOCKED
,424 FAILED_DEPENDENCY
,425 TOO_EARLY
,426 UPGRADE_REQUIRED
,428 PRECONDITION_REQUIRED
,429 TOO_MANY_REQUESTS
,431 REQUEST_HEADER_FIELDS_TOO_LARGE
,451 UNAVAILABLE_FOR_LEGAL_REASONS
,500 INTERNAL_SERVER_ERROR
,501 NOT_IMPLEMENTED
,502 BAD_GATEWAY
,503 SERVICE_UNAVAILABLE
,504 GATEWAY_TIMEOUT
,505 HTTP_VERSION_NOT_SUPPORTED
,506 VARIANT_ALSO_NEGOTIATES
,507 INSUFFICIENT_STORAGE
,508 LOOP_DETECTED
,509 BANDWIDTH_LIMIT_EXCEEDED
,510 NOT_EXTENDED
,511 NETWORK_AUTHENTICATION_REQUIRED
]HTTP status of the error response
- error string[]
List of error messages
- path string
Request path where the error occurred
{
"timestamp": "2024-07-15",
"status": "100 CONTINUE",
"error": [
"string"
],
"path": "string"
}